Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidying/Testing/Documenting Plasma #350

Merged

Conversation

aoifeboyle
Copy link
Contributor

To do:

  • Catch up on module tests.
  • Add more full plasma tests for more complex plasmas.
  • Add descriptions/latex names/latex formulae to start of new properties.
  • Documentation.
  • Produce proper graphs of properties for different plasmas to include in documentation.
  • Create comparisons of results between new and old plasma structures.
  • Reduce number of properties in graphs.

@aoifeboyle
Copy link
Contributor Author

@wkerzendorf I'm going back through all the properties and adding a few lines of description at the start of each property to summarise the outputs. The atomic file in this PR is an example. Let me know if there's any other details you think I should include. I was going to summarise the inputs for each property as well but I think that could get very repetitive.

Also, if you have time, let me know what you would like me to document! :)

@aoifeboyle
Copy link
Contributor Author

@wkerzendorf Quick question - are the latex formulae included in the plasma properties intended to go into the graph at some point, or are they just there for information?

Quick update: I was thinking about this some more, and I think it would be useful if the code could generate, as well as the graph, a separate Latex file with a list of properties and their formulae? I was also thinking about adding an option to the config file that allows the choice of whether to generate the graph and formula sheet as Latex files during each run or not.

Another update: I've added the ability to generate this kind of formula sheet. The latex names and formulae are now tuples to allow for multiple outputs with separate names. This just has a few properties as an example.
Sample_Formula_Sheet.pdf

@aoifeboyle
Copy link
Contributor Author

@wkerzendorf I've been working through some issues with the graphs as well. Could you please have a look at this one (for dilute-lte and nebular ionisation) and let me know what you think?

graph_nebular_dilute_lte.pdf

@aoifeboyle
Copy link
Contributor Author

@wkerzendorf I think the property graphs are becoming a bit too complicated (see the one above from a couple of weeks ago). I was thinking about maybe changing them so that atomic data properties aren't included (as they're static anyway). Let me know if there's any particular reason that I shouldn't do that.

@aoifeboyle
Copy link
Contributor Author

NLTE_graph.pdf

I've merged the NLTE branch and this is a version of the graph with the general NLTE settings. I think it's starting to get a bit unwieldy. Going to try to slim it down a bit. But it's working properly anyway.

@aoifeboyle
Copy link
Contributor Author

Much tidier graph!

Plasma_Graph.pdf

aoifeboyle pushed a commit that referenced this pull request Aug 5, 2015
@aoifeboyle aoifeboyle merged commit 2b95771 into tardis-sn:plasma/restructure Aug 5, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants